home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / hash / Hash_CreateEntry.man < prev    next >
Text File  |  1992-03-27  |  1KB  |  41 lines
  1. ' $Header: /sprite/src/lib/c/hash/RCS/Hash_CreateEntry.man,v 1.2 92/03/27 12:27:46 shirriff Exp $ SPRITE (Berkeley)
  2. .so \*(]ltmac.sprite
  3. .HS Hash_CreateEntry lib
  4. .BS
  5. .SH NAME
  6. Hash_CreateEntry, Hash_FindEntry \- keyed search in hash table 
  7. .SH SYNOPSIS
  8. .nf
  9. \fB#include <hash.h>\fR
  10.  
  11. Hash_Entry *
  12. \fBHash_CreateEntry\fR(\fItablePtr, key, newPtr\fR)
  13.  
  14. Hash_Entry *
  15. \fBHash_FindEntry\fR(\fItablePtr, key\fP)
  16. .AS Hash_Table *tablePtr
  17. .SH ARGUMENTS
  18. .AP Hash_Table *tablePtr in
  19. Table in which to search for entry or create new one.
  20. .AP Address key in
  21. Key value that identifies entry.  Exact nature depends on \fIkeyType\fP
  22. parameter passed to Hash_InitTable.
  23. .AP Boolean *newPtr in
  24. If non-NULL, then \fI*newPtr\fP is filled in with TRUE if a new entry
  25. was created, or FALSE if there was already an entry with the given
  26. key.
  27. .BE
  28.  
  29. .SH DESCRIPTION
  30. .LP
  31. Both \fBHash_FindEntry\fR and \fBHash_CreateEntry\fR search the hash table for
  32. an entry with the same key as \fIkey\fP.  If a matching entry is
  33. found, both return the address of that entry, which can then be used
  34. in \fBHash_GetValue\fR, \fBHash_SetValue\fR, and \fBHash_DeleteEntry\fR calls.  If
  35. no matching entry is found then \fBHash_FindEntry\fR returns NULL;
  36. in contrast, \fBHash_CreateEntry\fR will create a new entry with the given
  37. key and an initial value of NULL.
  38.  
  39. .SH KEYWORDS
  40. hash table, key, search
  41.